Declaration:

PROCEDURE   DelName

( name:STRING ) ;

Description:

Procedure DelName deletes an object name from a Vectorworks document. The associated object is not affected by the name deletion.

Parameters:

name	Object name to be deleted.

Declaration:

FUNCTION   GetColorName

( ColorIndex:INTEGER ) :STRING ;

Description:

Retrieves the color name of the specified color index.

Parameters:

ColorIndex

The index of the color

Result:

The name of the color specified by the index.

See Also:

SetColorName  

Declaration:

FUNCTION   GetDashStyleName

( DashStyleIndex:INTEGER ) :STRING ;

Description:

Retrieves the dash style name of the specified dash style index.

Parameters:

DashStyleIndex

The the index of the dash style.

Result:

Name of the dash style specified by the index.

See Also:

SetDashStyleName  

Declaration:

FUNCTION   GetName

( h:HANDLE ) :STRING ;

Description:

Function GetName returns the object name of the referenced object. The function returns None if the object has no object name.

A handle to layer may not passed to this routine; to obtain a layer name, use GetLName.

Parameters:

h	Handle to object.

Example:

ObjectName:=GetName(HandleToObject);

See Also:

SetName  

Declaration:

FUNCTION   GetObject

( name:STRING ) :HANDLE ;

Description:

Function GetObject returns a handle to a named object. If the name does not exist, NIL is returned.

Parameters:

name	Object name.

Declaration:

FUNCTION   Index2Name

( index:LONGINT ) :STRING ;

Description:

Function Index2Name returns the name of the object with specified index number.

Parameters:

index

Object index number.

Declaration:

FUNCTION   Name2Index

( name:STRING ) :LONGINT ;

Description:

Function Name2Index returns the internal index number for the specified object.

Parameters:

name	Name of object.

See Also:

SetSkylight   CreateSkylight   AddCavity  

Declaration:

FUNCTION   NameList

( index:LONGINT ) :STRING ;

Description:

Function NameList returns the specified object name from the object name list.

Parameters:

index

Name list position index (in a arange of 1 - n).

Declaration:

FUNCTION   NameNum

:LONGINT ;

Description:

Function NameNum returns the number of different object names in the active Vectorworks document.

Declaration:

PROCEDURE   NameObject

( objName:STRING ) ;

Description:

Procedure NameObject assigns an object name to the next object created.

Parameters:

objName

Name to be assigned to object.

Example:

NameObject('Part 5257');
Rect(0,2,2,0);

Declaration:

FUNCTION   SetColorName

(   ColorIndex :INTEGER;     ColorName :STRING ) :BOOLEAN ;

Description:

Sets the color name of the specified color index.

Parameters:

ColorIndex	The index of the color to be named.
ColorName	The new name of the color specified by the index.

Result:

'true' if the operation was successful.
'false' otherwise.

See Also:

GetColorName  

Declaration:

FUNCTION   SetDashStyleName

(   DashStyleIndex :INTEGER;     DashStyleName :STRING ) :BOOLEAN ;

Description:

Sets the dash style name of the specified dash style index.

Parameters:

DashStyleIndex	The index of the dash style to be named.
DashStyleName	The new name of the dash style specified by the index.

Result:

'true' if the operation was successful.
'false' otherwise.

See Also:

GetDashStyleName  

Declaration:

PROCEDURE   SetName

(   h :HANDLE;     name :STRING ) ;

Description:

Procedure SetName assigns a name to the referenced object.

Parameters:

h	Handle to object.
name	Name to be assigned to object.

Example:

PROCEDURE Example;
VAR
	h1    :HANDLE;
	SName :STRING;
BEGIN
	SName := 'Fred';
	h1 := CreateSphere(0, 0, 0, 1000);
	SetName(h1, SName);
END;
RUN(Example);

See Also:

GetName